home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / claqhe.z / claqhe
Encoding:
Text File  |  2002-10-03  |  4.1 KB  |  133 lines
  1.  
  2.  
  3.  
  4. CCCCLLLLAAAAQQQQHHHHEEEE((((3333SSSS))))                                                          CCCCLLLLAAAAQQQQHHHHEEEE((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CLAQHE - equilibrate a Hermitian matrix A using the scaling factors in
  10.      the vector S
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE CLAQHE( UPLO, N, A, LDA, S, SCOND, AMAX, EQUED )
  14.  
  15.          CHARACTER      EQUED, UPLO
  16.  
  17.          INTEGER        LDA, N
  18.  
  19.          REAL           AMAX, SCOND
  20.  
  21.          REAL           S( * )
  22.  
  23.          COMPLEX        A( LDA, * )
  24.  
  25. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  26.      These routines are part of the SCSL Scientific Library and can be loaded
  27.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  28.      directs the linker to use the multi-processor version of the library.
  29.  
  30.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  31.      4 bytes (32 bits). Another version of SCSL is available in which integers
  32.      are 8 bytes (64 bits).  This version allows the user access to larger
  33.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  34.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  35.      only one of the two versions; 4-byte integer and 8-byte integer library
  36.      calls cannot be mixed.
  37.  
  38. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  39.      CLAQHE equilibrates a Hermitian matrix A using the scaling factors in the
  40.      vector S.
  41.  
  42. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  43.      UPLO    (input) CHARACTER*1
  44.              Specifies whether the upper or lower triangular part of the
  45.              Hermitian matrix A is stored.  = 'U':  Upper triangular
  46.              = 'L':  Lower triangular
  47.  
  48.      N       (input) INTEGER
  49.              The order of the matrix A.  N >= 0.
  50.  
  51.      A       (input/output) COMPLEX array, dimension (LDA,N)
  52.              On entry, the Hermitian matrix A.  If UPLO = 'U', the leading n
  53.              by n upper triangular part of A contains the upper triangular
  54.              part of the matrix A, and the strictly lower triangular part of A
  55.              is not referenced.  If UPLO = 'L', the leading n by n lower
  56.              triangular part of A contains the lower triangular part of the
  57.              matrix A, and the strictly upper triangular part of A is not
  58.              referenced.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCLLLLAAAAQQQQHHHHEEEE((((3333SSSS))))                                                          CCCCLLLLAAAAQQQQHHHHEEEE((((3333SSSS))))
  71.  
  72.  
  73.  
  74.              On exit, if EQUED = 'Y', the equilibrated matrix:  diag(S) * A *
  75.              diag(S).
  76.  
  77.      LDA     (input) INTEGER
  78.              The leading dimension of the array A.  LDA >= max(N,1).
  79.  
  80.      S       (input) REAL array, dimension (N)
  81.              The scale factors for A.
  82.  
  83.      SCOND   (input) REAL
  84.              Ratio of the smallest S(i) to the largest S(i).
  85.  
  86.      AMAX    (input) REAL
  87.              Absolute value of largest matrix entry.
  88.  
  89.      EQUED   (output) CHARACTER*1
  90.              Specifies whether or not equilibration was done.  = 'N':  No
  91.              equilibration.
  92.              = 'Y':  Equilibration was done, i.e., A has been replaced by
  93.              diag(S) * A * diag(S).
  94.  
  95. PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRRSSSS
  96.      THRESH is a threshold value used to decide if scaling should be done
  97.      based on the ratio of the scaling factors.  If SCOND < THRESH, scaling is
  98.      done.
  99.  
  100.      LARGE and SMALL are threshold values used to decide if scaling should be
  101.      done based on the absolute size of the largest matrix element.  If AMAX >
  102.      LARGE or AMAX < SMALL, scaling is done.
  103.  
  104. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  105.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  106.  
  107.      This man page is available only online.
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.